Distributor Inventory Submission API
Response Attributes
/getStatus
Method: GET
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | totalPages | Number | "totalPages": 1 | Total Number of pages available for the response. | |
| 2 | totalRecords | Number | "totalRecords": 6356 | Total Number of records present in response | |
| 3 | page | Number | "page": 1 | page number for the search criteria | |
| 4 | limit | Boolean | "limit": 500 | page limit for the search criteria. Default: 500, Max:1000 | |
| 5 | next | Boolean | "next": 2 | Indicates the next page for search criteria. | |
| 6 | prev | Boolean | "prev": 1 | Indicates the prev page for search criteria. | |
| 7 | invRequestStatus.requestUUID | String | "requestUUID": "550e8400-e29b-41d4-a716-446655440000" | Unique request Id of the Inventory Submission | |
| 8 | invRequestStatus.requestStatus | String | "requestStatus": "SUCCESS" | Provides status of the request. | |
| 9 | invRequestStatus.message | String | "message": "Inventory data Processed Successfully." | Provides the overall submission status. | |
| 10 | invBatchDetails.batchId | Number | "batchId": 12345 | Batch id generated in the backend. | |
| 12 | invBatchDetails.submissionId | Number | "submissionId": 45678 | submissionId generated in the backend. | |
| 13 | invBatchDetails.batchStatus | Number | "batchStatus": "PENDING" | submissionId generated in the backend. | |
| 14 | requestDetails.header.biaRefNum | String | "biaRefNum": "123456" | biaRefNum from the submission. | |
| 15 | requestDetails.header.biaDate | String | "biaDate": "2024-04-09T00:00:00Z" | biaDate from the submission. | |
| 16 | requestDetails.header.sourceType | String | "sourceType": "WH" | sourceType from the submission. | |
| 17 | requestDetails.header.sourceName | String | "sourceName": "Example Inc." | Distributor Name | |
| 18 | requestDetails.header.sourceAddress1 | Double | "sourceAddress1": "123 Main St." | Address Line1 | |
| 19 | requestDetails.header.sourceAddress2 | String | "sourceAddress2": "Apt 101" | Address Line2 | |
| 20 | requestDetails.header.sourceCity | String | "sourceCity": "New York" | City | |
| 21 | requestDetails.header.sourceState | String | "sourceState": "NY" | State | |
| 22 | requestDetails.header.sourceCountryCode | String | "sourceCountryCode": "US" | Country Code | |
| 23 | requestDetails.lines.lineNum | Number | "lineNum": 54079 | Inventory Line Number | |
| 24 | requestDetails.lines.transId | Number | "transId": 563332976 | transaction id generated at the backend | |
| 25 | requestDetails.lines.invType | String | "invType": "PRIMARY" | Inventory Type | |
| 26 | requestDetails.lines.vendorPartNum | String | "vendorPartNum": "CN701" | Vendor Part Number | |
| 27 | requestDetails.lines.mfgPartNum | String | "mfgPartNum": "UG712" | Manufacturer Part Number | |
| 28 | requestDetails.lines.prodDesc | String | "prodDesc": "3.00 GHz E5-2690 v2/130W 10C/25MB Cache/DDR3 1866MHz" | product Description | |
| 29 | requestDetails.lines.qtyOnHand | Number | "qtyOnHand": 719 | quantity on Hand | |
| 30 | requestDetails.lines.qtyCommitted | Number | "qtyCommitted": 946 | quantity Committed | |
| 31 | requestDetails.lines.qtyForSale | Number | "qtyForSale": 446 | quantity For Sale | |
| 32 | requestDetails.lines.qtyOnOrder | Number | "qtyOnOrder": 72 | quantity on Order | |
| 33 | requestDetails.lines.qtyBackorder | Number | "qtyBackorder": 742 | quantity BackOrder | |
| 34 | requestDetails.lines.qtyInTransit | Number | "qtyInTransit": 742 | quantity Intransit | |
| 35 | requestDetails.lines.qtyOtherQual | Number | "qtyOtherQual": 38 | quantity others qualified | |
| 36 | requestDetails.lines.qtyOthers | Number | "qtyOthers": 445 | quantity others | |
| 37 | requestDetails.lines.lineStatus | String | "lineStatus": "INVALID" | Inventory Line Status after the validation | |
| 38 | requestDetails.lines.errorMessage | String | "errorMessage": "INVALID CISCO STANDARD PART NUMBER,PRODUCT FAMILY NOT FOUND,MISSING CISCO LIST PRICE" | Error description of the individual inventory line for correction. |
/submitInv
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | invRequestStatus.requestUUId | String | "requestUUId": "550e8400-e29b-41d4-a716-446655440000" | Unique request Id of the Inventory Submission. | |
| 2 | invRequestStatus.requestStatus | String | "requestStatus": "Success" | Inventory Submission Status | |
| 3 | invRequestStatus.message | String | "message": "Inventory submitted successfully" | Acknowledgement of the inventory submission | |
| 4 | invRequestStatus.timestamp | String | Date-Time | "timestamp": "2024-04-09T12:00:00Z" | Inventory Submission Time |
| 5 | links.rel | String | "rel": "Status" | Relates to the getStatus API | |
| 6 | links.href | String | "href": "/v1/disti/inventory/getStatus?requestId="550e8400-e29b-41d4-a716-446655440000"&page=1&limit=500" | getStatus API URL for the specific request id | |
| 7 | links.method | String | "method": "GET" | API Invoke Method |